Toolkit Testers’ Guide

Note

This page is for Toolkit Testers specifically.

This is a quick introduction to using the NG911-Pro GitHub Repository. The GitHub repository (“repo”) hosts downloadable releases of the Toolkit, the source code, and the issue tracker.

Registration

The 404 page an unregistered or unauthorized user might see.

The repo is private, meaning that only authorized GitHub users are able to access it. Anyone who isn’t authorized will see a 404 page when visiting the NG911-Pro GitHub Repository.

1. If you do not already have a GitHub account, navigate to signup and follow the instructions to register an account.

2. Once registered, send an email to the people below. Include your GitHub username.

Click here to automatically include the below recipients, or add the following manually:

• Emma Baker (ebaker@odot.org)

• Riley Baird (rbaird@odot.org)

• Brittney Williams (Brittney.Williams@odot.ok.gov)

• Colton Snelling (csnelling@odot.org)

You should receive a response in a timely fashion and should not have to repeat this process once complete.

Downloading the Latest Toolkit

Go to the main (“Code”) page of the repo. Above the file listing, click the Tags icon.

Click the first (latest) version.

Under Assets, select the first item, named something like NG911.Toolkit.v<version>.zip

Unzip the downloaded file. Once unzipped, you may delete the .zip file. In the unzipped folder, the file NG911_GIS_Toolkit_Pro.pyt is the ArcGIS Python Toolbox.

Warning

The unzipped folder may be moved in its entirety, but do not move, edit, or delete any of its contents.

Bug Reports & Feature Requests

GitHub’s issue tracker is to be used for reporting bugs and submitting specific, concrete requests for improvements or additions to the Toolkit. To submit any of these, go to the repo’s Issues section. To discuss more general ideas for improvements or additions to the Toolkit, see Feedback That Isn’t Issue-Worthy.

From the following types of issues, determine the one most applicable to your situation, then proceed.

Issue Types and Examples

Crash Report

• Tool crashes or fails unexpectedly

• Toolbox won’t open

• Tool fails to open

Bug Report

• Tool’s interface isn’t working correctly

• Output from a tool is incorrect

Improvement Suggestion

• Provide a better error message for a particular situation

• Rephrase/clarify a Validation message

• Rename a parameter to make more sense

New Tool Request

• Automate a time-consuming process not already done by another tool

On the Issues page, click New issue.

Next, you will select the appropriate issue template.

Fill out the form. If you’re submitting a Bug Report or Crash Report, don’t forget to attach your zipped geodatabase if it is relevant; we might not be able reproduce your problem without it!

Feedback That Isn’t Issue-Worthy

For questions and feedback that doesn’t fit into one of the categories under Bug Reports & Feature Requests, consider starting a Discussions thread under the most applicable category.

Discussion Categories

Ideas

If you have an action item to share but don’t quite have a specific, concrete solution in mind, post under Ideas. (If you do have a detailed solution in mind, open an Issue with the Improvement Suggestion template.)

Q&A

For assistance using the Toolkit or interpreting the results of a tool, post under Q&A. Please be sure to include the Toolkit version you are using. By asking questions here, we may be able to identify areas of the documentation, interface, and/or output in need of improvement. You could also check here to see if someone has already gotten an answer to a similar question!

General

For any other feedback that doesn’t fit the above categories, post under General.